home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / circuits / irsim-ca.2 / irsim-ca / irsim-cap-9.2 / man / irsim-analyzer.doc next >
Text File  |  1990-12-23  |  10KB  |  256 lines
  1.                                                 irsim-analyzer(3)
  2.  
  3. NAME
  4.      irsim-analyzer
  5.  
  6. SYNOPSIS
  7.      analyzer node...
  8.  
  9. DESCRIPTION
  10.      The analyzer provides a graphical interface to irsim;
  11.      displaying the state of the nodes (or vectors) node...
  12.  
  13.      Every invocation of the analyzer command adds a new set of
  14.      signals to the display list.
  15.  
  16.      The view is split into 3 regions: a trace window, a text
  17.      window, and a banner.  The banner displays the name of the
  18.      simulation (from the sim file), and the pull-down menu
  19.      headers.  The text window is a 1-line window used to request
  20.      and display certain information.
  21.  
  22.      The trace window displays the following information:
  23.  
  24.      left side:   names of the signals (nodes/vectors) displayed.
  25.  
  26.      top side:    On the left and right sides, the time
  27.                   corresponding to the left and right edges of
  28.                   the trace window.  In the center, the time of
  29.                   the current cursor position.
  30.  
  31.      right side:  Values of the signals under the cursor.
  32.  
  33.  
  34. MENU FUNCTIONS
  35.      zoom:
  36.            in   Zooms in by a factor of 2 (magnify).
  37.  
  38.            out  Zooms out by a factor of 2 (reduce).
  39.  
  40.      base:  Changes the numerical base used to display the value
  41.             of the selected vector (see below how to select a
  42.             trace) to one of the following:
  43.               bin  (base 2)
  44.               oct  (base 8)
  45.               hex  (base 16)
  46.  
  47.      window:1
  48.  
  49.           delta T     Allows to determine the difference (in
  50.                       time) between any two edges.   First click
  51.                       the mouse (any button) to the right of the
  52.                       first edge, then to the left of the second
  53.                       edge.  The time of the two edges as well as
  54.                       their difference will be shown in the text
  55.                       window.  As long as the button remains
  56.                       depressed, a line is shown between the two
  57.                       edges.  Times are all shown in ns.
  58.  
  59.           move to     Moves the left edge of the trace window to
  60.                       the specified time.  The time is requested
  61.                       in the text window.
  62.  
  63.           set width   Sets the number of ns. that will be
  64.                       displayed.  The time is requested in the
  65.                       text window.
  66.  
  67.           name length Since the most important differentiating
  68.                       information in a long signal name is
  69.                       usually at the end, the analyzer will
  70.                       display the last 15 characters of a signal
  71.                       name.  This option allows changing the
  72.                       maximum number of characters that will be
  73.                       displayed, which must be in the range [8-
  74.                       256].
  75.  
  76.           scroll      Usually the analyzer displays simulation
  77.                       activity by scrolling the traces to the
  78.                       left, so the last changes are shown. The
  79.                       scroll feature enables/disables this
  80.                       scrolling, effectively freezing the traces.
  81.                       When scrolling is enabled, a check mark is
  82.                       shown on this menu entry.
  83.  
  84.      print:  These options control the generation of a PostScript
  85.              file suitable for obtaining a hardcopy of the trace
  86.              window.
  87.  
  88.              file    Requests the filename to hold the PostScript
  89.                      output.  Hitting <return> will use the
  90.                      default name (shown in parens).  Hitting
  91.                      <ctrl-C> will abort generation of the file.
  92.                      The following menu entries control the
  93.                      aspect of the PostScript file; a check mark
  94.                      in the corresponding menu entry implies that
  95.                      the feature will be included in the output.
  96.  
  97.              banner  Generate a banner, showing the simulation
  98.                      name and current date.
  99.  
  100.              legend  Generate (in a separate page) a description
  101.                      of the signals displayed: the complete names
  102.                      of nodes (since the first characters may be
  103.                      stripped), and for vectors the names of the
  104.                      nodes of wich it is composed.
  105.  
  106.              times   Generate a time ruler at the bottom of the
  107.                      traces.
  108.  
  109.              outline Draw an outline around the trace window.
  110.  
  111. MOUSE FUNCTIONS
  112.      The analyzer provides various functions depending on where
  113.      in the window a mouse button is depressed.  All buttons have
  114.      the same meaning, except inside the scrollbar.  Pressing a
  115.      mouse button in the following regions will provide:
  116.  
  117.      Signal names:
  118.           The signal name where the button was depressed will be
  119.           highlighted and will be moved to the position where the
  120.           button is released, scrolling the other traces if
  121.           necessary.  If the button is released under the same
  122.           signal on which it was pressed, that signal will become
  123.           selected. The selected signal is always underlined, and
  124.           some information regarding that signal is printed in
  125.           the text window.
  126.  
  127.           If the button is released outside the traces area
  128.           (above or below) the signal will be removed from the
  129.           display.  It can only be added again by invoking the
  130.           analyzer command.
  131.  
  132.      Left Arrow:
  133.           The traces are scrolled left by half a page (move back
  134.           in time).
  135.  
  136.      Right Arrow:
  137.           The traces are scrolled right by half a page (move
  138.           forward in time).
  139.  
  140.      Double Left Arrow:
  141.           Scrolls traces left by a full page.
  142.  
  143.      Double Right Arrow:
  144.           Scrolls traces right by a full page.
  145.  
  146.      Scrollbar:
  147.           The left button allows to stretch the left side of the
  148.           window, thereby zooming in/out by an arbitrary amount.
  149.           The right side of the window remains the same.
  150.  
  151.           The right button allows to stretch the right side of
  152.           the window, thereby zooming in/out by an arbitrary
  153.           amount.  The left side of the window remains the same.
  154.  
  155.           The middle button moves the whole view back and forth
  156.           in time.  The magnification factor remains the same.
  157.  
  158.      Traces
  159.           The cursor is moved to the time-step where the mouse is
  160.           clicked.  Some lack of accuracy in selecting the time
  161.           may become apparent due to screen resolution round off.
  162.  
  163.           Holding down the shift key simultaneously with the
  164.           mouse button will not move the cursor, but rather show
  165.           the value of the signal at the time-step where the
  166.           mouse is clicked.  The value is printed in the text
  167.           window using the following format:
  168.  
  169.                name @  time:value=value,input=status
  170.  
  171.           The value is always shown in binary, regardless of the
  172.           base selected for that signal.  The status is a string
  173.           showing which nodes where inputs at that time.  Nodes
  174.           that were inputs have an i in their respective
  175.           position, otherwise an -.
  176.  
  177.      Cursor Values:
  178.           The selected signal value is highlighted and, when the
  179.           button is released, the value of the signal is expanded
  180.           in the text window.  This is useful for displaying each
  181.           of the bits that make up a vector.  The information
  182.           printed has the following format:
  183.  
  184.                 name:value=value input=status
  185.  
  186.           where value and status have the same meaning as above.
  187.  
  188.      Banner:
  189.           Clicking on the banner brings the window to the
  190.           foreground.
  191.  
  192.      Box on Banner:
  193.           Clicking in the little box on the left side of the
  194.           banner iconizes the analyzer window.  To de-iconize the
  195.           window, simply click any button within the icon.
  196.  
  197.      Banner Menus:
  198.           Pressing a mouse button in one of the banner menus (on
  199.           the right side) will pull down the corresponding menu.
  200.  
  201.  
  202.  
  203. X DEFAULTS
  204.      The analyzer application uses the appropriate resource
  205.      specification at startup time to customize the appearance of
  206.      its window.  The format for a resource specification in the
  207.      .Xdefaults file is:
  208.  
  209.                [name.]resource:  value
  210.  
  211.      For the analyzer, the available names are irsim and
  212.      analyzer. The available resources are:
  213.  
  214.  
  215.      background     Specifies the traces window background color.
  216.                     The default is black.
  217.  
  218.      foreground     Specifies the text color, or the background
  219.                     of everything else besides the traces window.
  220.                     The default is white.
  221.  
  222.      geometry       Specifies the default geometry (window size
  223.                     and screen location) of the graphic window.
  224.                     The default Xgeometry is "=1000x300+0+0".
  225.  
  226.      reverseVideo   Specifies whether the foreground and
  227.                     background colors are to be reversed (on
  228.                     monochrome displays only).  The default is
  229.                     off.
  230.  
  231.      font           Specifies the fixed-width font displayed.
  232.                     The default is 6x13.
  233.  
  234.      borderWidth    Specifies the width of the border (in
  235.                     pixels).  The default is 2.
  236.  
  237.      borderColor    Specifies the border color when the window is
  238.                     selected.  The default is black.
  239.  
  240.      highlight      Specifies the color used for highlighting.
  241.                     The default is red (color displays only).
  242.  
  243.      traceColor     Specifies the color in which the traces are
  244.                     drawn.  The default is white.
  245.  
  246.      bannerBg       Specifies the background color for the
  247.                     banner.  The default is white.
  248.  
  249.      bannerFg       Specifies the foreground (text) color for the
  250.                     banner.  The default is black.
  251.  
  252.  
  253. SEE ALSO
  254.      irsim(1)
  255.  
  256.